docs: add installation and usage guide for cz-ai plugin leveraging GP…#1458
docs: add installation and usage guide for cz-ai plugin leveraging GP…#1458Lee-W merged 1 commit intocommitizen-tools:masterfrom
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1458 +/- ##
==========================================
+ Coverage 97.33% 97.62% +0.28%
==========================================
Files 42 57 +15
Lines 2104 2653 +549
==========================================
+ Hits 2048 2590 +542
- Misses 56 63 +7
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
@watadarkstar Thanks! Looks good to me. Loop @bearomorphism in as I guess you might been interested in it? |
|
Thanks @Lee-W ! If you or @bearomorphism have any feedback feel free to DM me on X https://x.com/icookandcode |
Thanks! My X account has been broken recently though. |
No worries I'm also on Linkedin, Discord, etc. Just let me know what platform works for you and I can send you my details. |
|
Oh my x account is back |
Description
Add documentation for a new cz-ai commitizen plugin, including installation and usage instructions. This plugin leverages OpenAI’s GPT-4o to generate conventional commit messages automatically from staged git changes.
Closes #670
Checklist
Documentation Changes
poetry doclocally to ensure the documentation pages renders correctlyExpected Behavior
The documentation should clearly explain how to install and use the cz-ai plugin to generate conventional commit messages automatically.
Steps to Test This Pull Request
Additional Context
This addition introduces a new tool to improve commit message quality and consistency by leveraging AI, which could significantly streamline developer workflows.